home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / dmedia / dmTCAddTC.z / dmTCAddTC
Encoding:
Text File  |  2002-10-03  |  8.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC((((3333ddddmmmm))))                                                  ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      dmTCAddTC, dmTCAddFrames - digital media timecode mathematics
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____ttttiiiimmmmeeeeccccooooddddeeee....hhhh>>>>
  13.  
  14.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC
  15.          (((( DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee **** rrrreeeessssuuuulllltttt,,,,
  16.            ccccoooonnnnsssstttt DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee ****ssss1111,,,,
  17.            ccccoooonnnnsssstttt DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee ****ssss2222,,,,
  18.             iiiinnnntttt ****oooovvvveeeerrrrfffflllloooowwwwuuuunnnnddddeeeerrrrfffflllloooowwww ))))
  19.  
  20.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmTTTTCCCCAAAAddddddddFFFFrrrraaaammmmeeeessss
  21.          (((( DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee **** rrrreeeessssuuuulllltttt,,,,
  22.            ccccoooonnnnsssstttt DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee ****ssss1111,,,,
  23.            iiiinnnntttt ffffrrrraaaammmmeeeessss,,,,
  24.             iiiinnnntttt ****oooovvvveeeerrrrfffflllloooowwwwuuuunnnnddddeeeerrrrfffflllloooowwww ))))
  25.  
  26.  
  27.  
  28. TTTTYYYYPPPPEEEESSSS
  29.      _D_M_t_i_m_e_c_o_d_e   A structure containing a representation of SMPTE time code
  30.                   on which certain mathematical and utility functions can be
  31.                   performed.  Can be used with:  ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC((((3333ddddmmmm)))),
  32.                   ddddmmmmTTTTCCCCAAAAddddddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))), ddddmmmmTTTTCCCCTTTTooooSSSSttttrrrriiiinnnngggg((((3333ddddmmmm)))), ddddmmmmTTTTCCCCFFFFrrrroooommmmSSSSeeeeccccoooonnnnddddssss((((3333ddddmmmm)))),
  33.                   ddddmmmmTTTTCCCCTTTTooooSSSSeeeeccccoooonnnnddddssss((((3333ddddmmmm)))), ddddmmmmTTTTCCCCFFFFrrrroooommmmSSSSttttrrrriiiinnnngggg((((3333ddddmmmm)))),
  34.                   ddddmmmmTTTTCCCCFFFFrrrraaaammmmeeeessssPPPPeeeerrrrDDDDaaaayyyy((((3333ddddmmmm)))), and ddddmmmmTTTTCCCCFFFFrrrraaaammmmeeeessssBBBBeeeettttwwwweeeeeeeennnn((((3333ddddmmmm)))).  Can also
  35.                   be used with the ddddmmmmLLLLTTTTCCCC((((3333ddddmmmm)))) and ddddmmmmVVVVIIIITTTTCCCC((((3333ddddmmmm)))) routines.  See
  36.                   also DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee((((3333ddddmmmm)))).
  37.  
  38.  
  39. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  40.      _r_e_s_u_l_t   The result of the addition operation. Note that this must be a
  41.               valid pointer, and should not point to the same _D_M_t_i_m_e_c_o_d_e as _s_1
  42.               or _s_2.
  43.  
  44.  
  45.      _s_1, _s_2   The timecode operand(s) to be used in the addition.
  46.  
  47.  
  48.      _f_r_a_m_e_s   The number of frames to add to the operand _s_1.
  49.  
  50.  
  51.      _u_n_d_e_r_f_l_o_w_o_v_e_r_f_l_o_w
  52.               An optional argument so that the user of the library can tell if
  53.               an underflow or overflow condition occurred. If the app doesn't
  54.               care about overflow/underflow, it should pass in NULL.
  55.               Otherwise, _u_n_d_e_r_f_l_o_w_o_v_e_r_f_l_o_w will be set to 0 (normal), a
  56.               positive number (overflow), or a negative number (underflow).
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC((((3333ddddmmmm))))                                                  ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  75.      ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC adds operand _s_1 to operand _s_2. It returns the result of the
  76.      addition in _r_e_s_u_l_t. The tc_type of _r_e_s_u_l_t will be the same as the tc_type
  77.      of the operands. It is required that the tc_type of _s_1 be the same as the
  78.      tc_type of _s_2. See NNNNOOOOTTTTEEEESSSS for information on adding timecodes of differing
  79.      tc_type. ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC will return DM_FAILURE if the addition failed. See
  80.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE.
  81.  
  82.      ddddmmmmTTTTCCCCAAAAddddddddFFFFrrrraaaammmmeeeessss adds _f_r_a_m_e_s video frames to operand _s_1 and returns the
  83.      result in _r_e_s_u_l_t. The tc_type of _r_e_s_u_l_t will be the same tc_type as _s_1.
  84.      It is acceptable for _f_r_a_m_e_s to be a negative value, but overflowunderflow
  85.      from ddddmmmmTTTTCCCCAAAAddddddddFFFFrrrraaaammmmeeeessss should be checked to verify that there was no
  86.      underflow condition.
  87.  
  88.  
  89. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  90.      If a DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee operand (_s_1 or _s_2) contains an illegal timecode value
  91.      (e.g., a negative entry, invalid frame number, etc.), these functions
  92.      will return DM_FAILURE, and the contents of _r_e_s_u_l_t will be undefined.
  93.  
  94.      If the result of the addition overflows or underflows the 24 hour period,
  95.      these functions will return DM_SUCCESS, and the contents of _r_e_s_u_l_t will
  96.      have wrapped to a 24 hour clock. The _o_v_e_r_f_l_o_w_u_n_d_e_r_f_l_o_w parameter will
  97.      have been set, however, on an underflow or overflow condition.
  98.  
  99.      ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC and ddddmmmmTTTTCCCCAAAAddddddddFFFFrrrraaaammmmeeeessss return DM_SUCCESS upon successful completion
  100.      of the addition operation.
  101.  
  102.  
  103. NNNNOOOOTTTTEEEESSSS
  104.      In order for DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee's of differing _t_c__t_y_p_e (e.g., DM_TC_30_ND and
  105.      DM_TC_2997_4FIELD_DROP) to be added, they must first be converted to
  106.      either frames or seconds, and added as either frames or seconds, as
  107.      appropriate for the situation.  Note that when adding DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee's with
  108.      different tc_type's, different results may be obtained by adding them as
  109.      seconds or as frames--which is why ddddmmmmTTTTCCCCAAAAddddddddTTTTCCCC does not allow two
  110.      DDDDMMMMttttiiiimmmmeeeeccccooooddddeeee's of different tc_type's to be added.
  111.  
  112.  
  113. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  114.      dmTCFromSeconds(3dm), dmTCToSeconds(3dm), dmTCFromString(3dm),
  115.      dmTCFromString(3dm), dmTCFramesPerDay(3dm), dmTCFramesBetween(3dm),
  116.      dmLTC(3dm), dmVITC(3dm)
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.